Platform Explorer / Nuxeo Platform 2021.61

Operation Repository.ResultSetPageProvider (QueryAndFetch)

Description

Perform a named provider query on the repository. Result is paginated.The result is returned as a RecordSet (QueryAndFetch) rather than as a List of DocumentThe query result will become the input for the next operation.
Operation id Repository.ResultSetPageProvider
AliasesResultset.PageProvider
Category Fetch
Label QueryAndFetch
Requires
Since

Parameters

Name Description Type Required Default value
currentPageIndex integer no  
language string no NXQL, CMIS 
maxResults string no  
namedParameters Named parameters to pass to the page provider to fill in query variables. properties no  
pageSize integer no  
providerName string no  
queryParams stringlist no  
sortBy Sort by properties (separated by comma) stringlist no  
sortOrder Sort order, ASC or DESC stringlist no ASC, DESC 

Signature

Inputs void
Outputs recordset

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.ResultSetPageProviderOperation
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Repository.ResultSetPageProvider",
  "aliases" : [ "Resultset.PageProvider" ],
  "label" : "QueryAndFetch",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a named provider query on the repository. Result is paginated.The result is returned as a RecordSet (QueryAndFetch) rather than as a List of DocumentThe query result will become the input for the next operation.",
  "url" : "Repository.ResultSetPageProvider",
  "signature" : [ "void", "recordset" ],
  "params" : [ {
    "name" : "currentPageIndex",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL", "CMIS" ]
  }, {
    "name" : "maxResults",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "namedParameters",
    "description" : "Named parameters to pass to the page provider to fill in query variables.",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "providerName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortBy",
    "description" : "Sort by properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : "Sort order, ASC or DESC",
    "type" : "stringlist",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ]
}